Improve Exports #686
Merged
Improve Exports #686
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 3a6cae5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 13 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
rkistner
reviewed
Aug 4, 2025
rkistner
reviewed
Aug 4, 2025
…mmonjs+node16 resolution
rkistner
approved these changes
Aug 5, 2025
Chriztiaan
approved these changes
Aug 5, 2025
whygee-dev
pushed a commit
to whygee-dev/powersync-js
that referenced
this pull request
Oct 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
The PowerSync Node.js SDK currently provides both ESM and CommonJS exports for compatibility with different environments. However, some related packages such as the Drizzle and Kysely drivers export ESM JavaScript without explicitly declaring the package as an ES module.
While this isn't an issue for bundled applications, it causes problems when the packages are imported directly into a Node.js application. In such cases, Node.js assumes the packages use CommonJS and fails to load them due to the presence of ESM syntax like
importandexport.For additional context. See microsoft/TypeScript#60663
This PR updates the affected packages to explicitly export both ESM and CommonJS (now added via Rollup). As with other packages in this repo - modules are compiled with TypeScript by targeting ES. Rollup is used to compile a CommonJS export which is declared in the
package.jsonfile.A small test suite has also been added to verify that the packages load correctly in both environments.
A test for checking package exports via the Are The Types Wrong CLI has been added for relevant packages. Most packages have been updated with tests. Testing focus has been applied to packages which might be used in a Node.js environment. React native specific packages are not modified in this PR.
Package Changes Summary
@powersync/attachments: Added a CJS export which is generated via Rollup.@powersync/common: Added CJS Type declarations.@powersync/drizzle-driver: Added a CJS export which is generated via Rollup.@powersync/kysely-driver: Added a CJS export which is generated via Rollup.@powersync/node: Added CJS Type declarations@powersync/react: Declared the module as amodule. We currently only provide ES exports for this package.@powersync/vue: Declared the module as amodule. We currently only provide ES exports for this package.@powersync/tanstack-react-query: Declared the module as amodule. We currently only provide ES exports for this package.